Skip to content

Directory.md #884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 5 commits into from
Closed

Directory.md #884

wants to merge 5 commits into from

Conversation

jaspalsb
Copy link

@jaspalsb jaspalsb commented Jun 7, 2019

Directory that was suggested in #860

poyea
poyea approved these changes Jun 8, 2019
View reviewed changes
Copy link
Member

@poyea poyea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. Do you have any ideas on how to automate this? Otherwise, we'd need all code contributors to modify this each time they open a PR.

@AnupKumarPanwar
Copy link
Member

@jaspalsb We will keep this on hold for now, as I'm thinking to include something similar in the README file itself, as it will allow easy navigation to the algorithms for those whole are coming for learning purpose. And yes, it is an overhead to update README file every time with the PR, but we can think of some automation script for it. But as of now, we will keep this PR on hold. Thanks for the work.

@poyea
Copy link
Member

poyea commented Jul 5, 2019

The automated script is available at /~script.py. However, I haven't completely test it. We may consider trying to integrate it with other bots/CI checks, and then we don't need to create these PRs. @AnupKumarPanwar

@AnupKumarPanwar
Copy link
Member

@poyea Actually it is not necessary to generate this content list. My idea is to just make a good README file for the repo and I think adding the list of algorithms to readme is a good idea. If you can suggest some good content for the README then please go ahead, but that should not cause an overhead of updating it in every PR. I know my idea will lead to an overhead. I want some good suggestions from you.

cclauss added a commit that referenced this pull request Jul 6, 2019
@cclauss
Travis CI: Build Directory.md
2a27011 
As suggested at #884 (comment)
@cclauss cclauss mentioned this pull request Jul 6, 2019
Closed
@cclauss
Copy link
Member

cclauss commented Jul 6, 2019

Do you have any ideas on how to automate this?

#964

@poyea
Copy link
Member

poyea commented Jul 8, 2019

I'm closing this as this is resolved by other PRs. We don't have to worry about the file now. Thank you for your pull request!🤩

@poyea poyea closed this Jul 8, 2019
@QuantumNovice
Copy link
Contributor

Change this to os.walk. If greater speed is required use fastio.walk.

Python/scripts/build_directory_md.py

Lines 20 to 29 in 05e567c

for i in os.listdir(parent):
full = os.path.join(parent, i)
name, ext = os.path.splitext(i)
if i not in ignores and ext not in ignores_ext:
if os.path.isfile(full):
# generate list
pre = parent.replace("./", "").replace(" ", "%20")
# replace all spaces to safe URL
child = i.replace(" ", "%20")
files.append((pre, child, name))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@poyea poyea poyea approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jaspalsb @AnupKumarPanwar @poyea @cclauss @QuantumNovice